home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / catD / nic.z / nic
Encoding:
Text File  |  2002-10-03  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. nnnniiiicccc((((DDDD3333))))                                                                nnnniiiicccc((((DDDD3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _nnnn_iiii_cccc______vvvv_eeee_rrrr_tttt_eeee_xxxx______iiii_nnnn_ffff_oooo______ssss_eeee_tttt - decode NIC, label vertex
  10.      _nnnn_iiii_cccc______vvvv_eeee_rrrr_tttt_eeee_xxxx______iiii_nnnn_ffff_oooo______gggg_eeee_tttt - get decoded NIC data from vertex
  11.      _nnnn_iiii_cccc______vvvv_eeee_rrrr_tttt_eeee_xxxx______iiii_nnnn_ffff_oooo______mmmm_aaaa_tttt_cccc_hhhh - check for NIC data match
  12.      _nnnn_iiii_cccc______vvvv_mmmm_cccc______aaaa_dddd_dddd - establish callback based on NIC data match
  13.      _nnnn_iiii_cccc______vvvv_mmmm_cccc______dddd_eeee_llll - deactivate NIC data match callback
  14.      _nnnn_iiii_cccc______aaaa_cccc_cccc_eeee_ssss_ssss______mmmm_cccc_rrrr_3333_2222 - common NIC access function
  15.  
  16. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  17.      #include <sys/nic.h>
  18.  
  19.      char *
  20.      nic_vertex_info_set(
  21.                nic_access_t _a_c_c_e_s_s,
  22.                nic_data_t _d_a_t_a,
  23.                vertex_hdl_t _v_h_d_l)
  24.  
  25.      char *
  26.      nic_vertex_info_get(
  27.                vertex_hdl_t _v_h_d_l)
  28.  
  29.      int
  30.      nic_vertex_info_match(
  31.                vertex_hdl_t _v_h_d_l,
  32.                char *_s_t_r_i_n_g)
  33.  
  34.      nic_vmce_t
  35.      nic_vmc_add(
  36.                char *_s_t_r_i_n_g,
  37.                nic_vmc_func *_f_u_n_c)
  38.  
  39.      void
  40.      nic_vmc_del(
  41.                nic_vmce_t _e_n_t_r_y)
  42.  
  43.      nic_access_f   nic_access_mcr32;
  44.  
  45.    AAAArrrrgggguuuummmmeeeennnnttttssss
  46.      _a_c_c_e_s_s  is a NIC access function appropriate for the ASIC through which
  47.              the NIC is going to be accessed.
  48.  
  49.      _d_a_t_a    is an appropriate value to pass as the first parameter to the
  50.              access function; it is commonly an address through which the NIC
  51.              will be accessed.
  52.  
  53.      _e_n_t_r_y   is an appropriate value returned from a previous _n_i_c__v_m_c__a_d_d()
  54.              function call.
  55.  
  56.      _s_t_r_i_n_g  is data to be found as a substring of the decoded NIC data.  Most
  57.              commonly, it will be a seven digit SGI board part number.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. nnnniiiicccc((((DDDD3333))))                                                                nnnniiiicccc((((DDDD3333))))
  71.  
  72.  
  73.  
  74.      _v_h_d_l    is an appropriate handle to a vertex corresponding to the device
  75.              to which the NIC is attached.
  76.  
  77. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  78.      The first time _n_i_c__v_e_r_t_e_x__i_n_f_o__s_e_t() is called, it extracts and decodes
  79.      the data from a NIC using the specified access function and data value,
  80.      then annotates the specified vertex with the decoded data.  The NIC
  81.      callback list is checked, and any matching callbacks are triggered.
  82.      Subsequent calls merely return the decoded data already on the vertex.
  83.  
  84.      _n_i_c__v_e_r_t_e_x__i_n_f_o__g_e_t() returns the decoded NIC data attached to the
  85.      specified vertex, or NULL if no decode has been attempted.
  86.  
  87.      _n_i_c__v_e_r_t_e_x__i_n_f_o__m_a_t_c_h() retrieves the NIC data for the specified vertex,
  88.      and checks to see if the specified string is a substring in the decoded
  89.      NIC data, returning nonzero if there is a match.
  90.  
  91.      _n_i_c__v_m_c__a_d_d() is used to establish a NIC data based callback; after this
  92.      call is made, each NIC data decode will also check for a match with the
  93.      specified string, and if there is a match, the callback function will be
  94.      triggered with the appropriate vertex passed to it.
  95.  
  96.      _n_i_c__v_m_c__d_e_l() is used to tear down a NIC data based callback.
  97.  
  98.      _n_i_c__a_c_c_e_s_s__m_c_r_3_2() is a common NIC access function used by several ASICs
  99.      in current systems.
  100.  
  101. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  102.      _n_i_c__v_e_r_t_e_x__i_n_f_o__g_e_t() returns NULL if there is no decoded NIC data
  103.      attached to the specified vertex.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.